home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2002 #12 / Amiga Plus CD - 2002 - No. 12.iso / Tools / Development / pv-0.2.6 / doc / pv.info < prev    next >
Encoding:
GNU Info File  |  2002-11-17  |  9.3 KB  |  288 lines
  1. This is Info file doc/pv.info, produced by Makeinfo version 1.68 from
  2. the input file doc/manual.texi.
  3.  
  4. INFO-DIR-SECTION Miscellaneous
  5. START-INFO-DIR-ENTRY
  6. * PV: (pv).             Monitor the progress of data through a pipe.
  7. END-INFO-DIR-ENTRY
  8.  
  9.    This file documents the "pv" package, version 0.2.6.
  10.  
  11.    Copyright 2002 Andrew Wood
  12.  
  13.    Permission is granted to make and distribute verbatim copies of this
  14. manual provided the copyright notice and this permission notice are
  15. preserved on all copies.
  16.  
  17.    Permission is granted to copy and distribute modified versions of
  18. this manual under the conditions for verbatim copying, provided that
  19. the entire resulting derived work is distributed under the terms of a
  20. permission notice identical to this one.
  21.  
  22.    Permission is granted to copy and distribute translations of this
  23. manual into another language, under the above conditions for modified
  24. versions, except that this permission notice may be stated in a
  25. translation approved by Andrew Wood.
  26.  
  27. 
  28. File: pv.info,  Node: Top,  Next: Overview,  Up: (dir)
  29.  
  30. Pipe Viewer
  31. ***********
  32.  
  33.    This edition of the `PV manual', last updated 19 July 2002,
  34. documents `pv' version 0.2.6.
  35.  
  36. * Menu:
  37.  
  38. * Overview::           Overview of `pv'.
  39. * Invocation::         Invoking `pv'.
  40.  
  41. * Concept Index::      Index of concepts.
  42.  
  43.  -- The Detailed Node Listing --
  44.  
  45. * Display switches::   Options to change which information is shown.
  46. * Output modifiers::   Options altering the way this information is given.
  47. * General options::    Everything that's left over.
  48.  
  49. 
  50. File: pv.info,  Node: Overview,  Next: Invocation,  Prev: Top,  Up: Top
  51.  
  52. Overview
  53. ********
  54.  
  55.    This is the documentation for `pv', a terminal-based tool for
  56. monitoring the progress of data through a pipeline.  It can be inserted
  57. into any normal pipeline between two processes to give a visual
  58. indication of how quickly data is passing through, how long it has
  59. taken, how near to completion it is, and an estimate of how long it
  60. will be until completion.
  61.  
  62. 
  63. File: pv.info,  Node: Invocation,  Next: Display switches,  Prev: Overview,  Up: Top
  64.  
  65. Invocation
  66. **********
  67.  
  68.    Summary: `pv [OPTION] [FILE]...'
  69.  
  70.    To use `pv', insert it in a pipeline between two processes, with the
  71. appropriate options.  Its standard input will be passed through to its
  72. standard output and progress will be shown on standard error.
  73.  
  74.    `pv' will copy each supplied FILE in turn to standard output (`-'
  75. means standard input), or if no FILEs are specified just standard input
  76. is copied.  This is the same behaviour as `cat'.
  77.  
  78.    A simple example to watch how quickly a file is transferred using
  79. `nc':
  80.  
  81.      pv file | nc -w 1 somewhere.com 3000
  82.  
  83.    A similar example, transferring a file from another process and
  84. passing the expected size to `pv':
  85.  
  86.      cat file | pv -s 12345 | nc -w 1 somewhere.com 3000
  87.  
  88.    A more complicated example using numeric output to feed into the
  89. `dialog' program for a full-screen progress display:
  90.  
  91.      (tar cf - . \
  92.       | pv -n -s `du -sb . | awk '{print $1}'` \
  93.       | gzip -9 > out.tgz) 2>&1 \
  94.      | dialog --gauge 'Progress' 7 70
  95.  
  96.    Frequent use of this third form is not recommended as it may cause
  97. the programmer to overheat.
  98.  
  99.    `pv' takes many options, which are divided into display switches,
  100. output modifiers, and general options.
  101.  
  102. * Menu:
  103.  
  104. * Display switches::   Options to change which information is shown.
  105. * Output modifiers::   Options altering the way this information is given.
  106. * General options::    Everything that's left over.
  107.  
  108. 
  109. File: pv.info,  Node: Display switches,  Next: Output modifiers,  Prev: Invocation,  Up: Invocation
  110.  
  111. Display switches
  112. ================
  113.  
  114.    If no display switches are specified, `pv' behaves as if `-p', `-t',
  115. `-e', `-r', and `-b' had been given (i.e. everything is switched on).
  116. Otherwise, only those display types that are explicitly switched on
  117. will be shown.
  118.  
  119. `-p'
  120. `--progress'
  121.      Turn the progress bar on.  If standard input is not a file and no
  122.      size was given (with the `-s' modifier), the progress bar cannot
  123.      indicate how close to completion the transfer is, so it will just
  124.      move left and right to indicate that data is moving.
  125.  
  126. `-t'
  127. `--timer'
  128.      Turn the timer on.  This will display the total elapsed time that
  129.      `pv' has been running for.
  130.  
  131. `-e'
  132. `--eta'
  133.      Turn the ETA timer on.  This will attempt to guess, based on
  134.      previous transfer rates and the total data size, how long it will
  135.      be before completion.  This option will have no effect if the
  136.      total data size cannot be determined.
  137.  
  138. `-r'
  139. `--rate'
  140.      Turn the rate counter on.  This will display the current rate of
  141.      data transfer.
  142.  
  143. `-b'
  144. `--bytes'
  145.      Turn the total byte counter on.  This will display the total
  146.      amount of data transferred so far.
  147.  
  148. `-n'
  149. `--numeric'
  150.      Numeric output.  Instead of giving a visual indication of progress,
  151.      `pv' will give an integer percentage, one per line, on standard
  152.      error, suitable for piping (via convoluted redirection) into the
  153.      `dialog' program.  Note that `-f' is not required if `-n' is being
  154.      used.
  155.  
  156. `-q'
  157. `--quiet'
  158.      No output.  Useful if the `-L' option is being used on its own to
  159.      just limit the transfer rate of a pipe.
  160.  
  161. 
  162. File: pv.info,  Node: Output modifiers,  Next: General options,  Prev: Display switches,  Up: Invocation
  163.  
  164. Output modifiers
  165. ================
  166.  
  167. `-L RATE'
  168. `--rate-limit RATE'
  169.      Limit the transfer to a maximum of RATE bytes per second.
  170.  
  171. `-W'
  172. `--wait'
  173.      Wait until the first byte has been transferred before showing any
  174.      progress information or calculating any ETAs.  Useful if the
  175.      program you are piping to or from requires extra information
  176.      before it starts, eg piping data into `gpg' or `mcrypt' which
  177.      require a passphrase before data can be processed.
  178.  
  179. `-s SIZE'
  180. `--size SIZE'
  181.      Assume the total amount of data to be transferred is SIZE bytes
  182.      when calculating percentages and ETAs.
  183.  
  184. `-i SEC'
  185. `--interval SEC'
  186.      Wait SEC seconds between updates.  The default is to update every
  187.      second.
  188.  
  189. `-w WIDTH'
  190. `--width WIDTH'
  191.      Assume the terminal is WIDTH characters wide, instead of trying to
  192.      work it out (or assuming 80 if it cannot be guessed).
  193.  
  194. `-N NAME'
  195. `--name NAME'
  196.      Prefix the output information with NAME. Useful in conjunction with
  197.      `-c' if you have a complicated pipeline and you want to be able to
  198.      tell different parts of it apart.
  199.  
  200. `-f'
  201. `--force'
  202.      Force output.  Normally, `pv' will not output any visual display
  203.      if standard error is not a terminal.  This option forces it to do
  204.      so.
  205.  
  206. `-c'
  207. `--cursor'
  208.      Use cursor positioning escape sequences instead of just using
  209.      carriage returns.  This is useful in conjunction with `-N' (name)
  210.      if you are using multiple `pv' invocations in a single, long,
  211.      pipeline.  However, it is likely to result in a garbled display if
  212.      used near the bottom of the screen and should be considered
  213.      slightly experimental.
  214.  
  215. 
  216. File: pv.info,  Node: General options,  Prev: Output modifiers,  Up: Invocation
  217.  
  218. General options
  219. ===============
  220.  
  221. `-h'
  222. `--help'
  223.      Print a usage message on standard output and exit successfully.
  224.  
  225. `-l'
  226. `--license'
  227.      Print details of the program's license on standard output and exit
  228.      successfully.
  229.  
  230. `-V'
  231. `--version'
  232.      Print version information on standard output and exit successfully.
  233.  
  234. 
  235. File: pv.info,  Node: Concept Index,  Up: Top
  236.  
  237. Concept Index
  238. *************
  239.  
  240. * Menu:
  241.  
  242. * Bytes transferred:                     Display switches.
  243. * Completion time:                       Display switches.
  244. * Cursor positioning:                    Output modifiers.
  245. * Data size:                             Output modifiers.
  246. * Dialog, output to:                     Display switches.
  247. * Elapsed time:                          Display switches.
  248. * ETA:                                   Display switches.
  249. * Example, using dialog:                 Invocation.
  250. * Example, using nc:                     Invocation.
  251. * Force terminal output:                 Output modifiers.
  252. * Interval:                              Output modifiers.
  253. * Limiting transfer rate:                Output modifiers.
  254. * Name:                                  Output modifiers.
  255. * No output:                             Display switches.
  256. * Numeric output:                        Display switches.
  257. * Output width:                          Output modifiers.
  258. * Percentage only output:                Display switches.
  259. * Prefix:                                Output modifiers.
  260. * Progress bar:                          Display switches.
  261. * Quiet (no output):                     Display switches.
  262. * Rate:                                  Display switches.
  263. * Rate limiting:                         Output modifiers.
  264. * Silent (no output):                    Display switches.
  265. * Size:                                  Output modifiers.
  266. * Terminal width:                        Output modifiers.
  267. * Time, elapsed:                         Display switches.
  268. * Time, until completion:                Display switches.
  269. * Timer:                                 Display switches.
  270. * Transfer rate:                         Display switches.
  271. * Update interval:                       Output modifiers.
  272. * Wait:                                  Output modifiers.
  273. * Wait until transfer starts:            Output modifiers.
  274. * Width:                                 Output modifiers.
  275.  
  276.  
  277. 
  278. Tag Table:
  279. Node: Top989
  280. Node: Overview1529
  281. Node: Invocation1986
  282. Node: Display switches3488
  283. Node: Output modifiers5193
  284. Node: General options6941
  285. Node: Concept Index7341
  286. 
  287. End Tag Table
  288.